/*
    * Copyright (C) 2012 The Guava Authors
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package com.google.common.collect.testing.google;
  
  import com.google.common.annotations.GwtCompatible;
  import com.google.common.collect.BiMap;
  import com.google.common.collect.testing.AbstractMapTester;
  import com.google.common.collect.testing.Helpers;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.List;
  import java.util.Map.Entry;
  
  /**
   * Skeleton for a tester of a {@code BiMap}.
   */
  @GwtCompatible
  public abstract class AbstractBiMapTester<K, V> extends AbstractMapTester<K, V> {
  
    @Override
    protected BiMap<K, V> getMap() {
      return (BiMap<K, V>) super.getMap();
    }
  
    static <K, V> Entry<V, K> reverseEntry(Entry<K, V> entry) {
      return Helpers.mapEntry(entry.getValue(), entry.getKey());
    }
  
    @Override
    protected void expectContents(Collection<Entry<K, V>> expected) {
      super.expectContents(expected);
      List<Entry<V, K>> reversedEntries = new ArrayList<Entry<V, K>>();
      for (Entry<K, V> entry : expected) {
        reversedEntries.add(reverseEntry(entry));
      }
      Helpers.assertEqualIgnoringOrder(getMap().inverse().entrySet(), reversedEntries);
  
      for (Entry<K, V> entry : expected) {
        assertEquals("Wrong key for value " + entry.getValue(), entry.getKey(), getMap()
            .inverse()
            .get(entry.getValue()));
      }
    }
  
    @Override
    protected void expectMissing(Entry<K, V>... entries) {
      super.expectMissing(entries);
      for (Entry<K, V> entry : entries) {
        Entry<V, K> reversed = reverseEntry(entry);
        BiMap<V, K> inv = getMap().inverse();
        assertFalse("Inverse should not contain entry " + reversed,
            inv.entrySet().contains(entry));
        assertFalse("Inverse should not contain key " + entry.getValue(),
            inv.containsKey(entry.getValue()));
        assertFalse("Inverse should not contain value " + entry.getKey(),
            inv.containsValue(entry.getKey()));
        assertNull("Inverse should not return a mapping for key " + entry.getValue(),
            getMap().get(entry.getValue()));
      }
    }
  
  }